<!doctype html>


<html>
<head>
  <link rel="shortcut icon" href="static/images/favicon.ico" type="image/x-icon">
  <title>BrowserChannel (Closure Library API Documentation - JavaScript)</title>
  <link rel="stylesheet" href="static/css/base.css">
  <link rel="stylesheet" href="static/css/doc.css">
  <link rel="stylesheet" href="static/css/sidetree.css">
  <link rel="stylesheet" href="static/css/prettify.css">

  <script>
     var _staticFilePath = "static/";
  </script>

  <script src="static/js/doc.js">
  </script>

  <meta charset="utf8">
</head>

<body onload="prettyPrint()">

<div id="header">
  <div class="g-section g-tpl-50-50 g-split">
    <div class="g-unit g-first">
      <a id="logo" href="index.html">Closure Library API Documentation</a>
    </div>

    <div class="g-unit">
      <div class="g-c">
        <strong>Go to class or file:</strong>
        <input type="text" id="ac">
      </div>
    </div>
  </div>
</div>





<div class="colmask rightmenu">
<div class="colleft">
    <div class="col1">
      <!-- Column 1 start -->

<div id="title">
        <span class="fn">net.BrowserChannel</span>
        <span>Extends</span>
        <span class="fn-name">
          <a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Object">
            Object</a>
        </span>
</div>

<div class="g-section g-tpl-75-25">
  <div class="g-unit g-first" id="description">
    Encapsulates the logic for a single BrowserChannel.
  </div>


        <div class="g-unit" id="useful-links">
          <div class="title">Useful links</div>
          <ol>
            <li><a href="closure_goog_net_browserchannel.js.source.html"><span class='source-code-link'>Source Code</span></a></li>
          </ol>
        </div>
</div>






<h2 class="g-first">Inheritance</h2>
<pre class="inheritance">
Object
     <img src="static/images/inherit.gif">goog.net.BrowserChannel
</pre>




  <h2>Constructor</h2>
      <div class="fn-constructor">
    goog.net.BrowserChannel(<span><span class="arg">clientVersion</span></span>)
  </div>

   <h3>Parameters</h3>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">clientVersion</span>
        : <div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span></div>
        <div class="entryOverview">An application-specific version number that is sent to the server when connected.</div>
     </td>
   </tr>
  </table>


<h2>Instance Methods</h2>


  <div class="legend">
        <span class="key publickey"></span><span>Public</span>
        <span class="key protectedkey"></span><span>Protected</span>
        <span class="key privatekey"></span><span>Private</span>
  </div>







<div>
       <div class="desc">
         Defined in
         <span class="fn-name">
            <a href="class_goog_net_BrowserChannel.html">
              goog.net.BrowserChannel
            </a>
         </span>
       </div>






<div class="section">
  <table class="horiz-rule">


     <tr class="even entry private">
       <td class="access"></td>






  <td>
    <a name="goog.net.BrowserChannel.prototype.addAdditionalParams_"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">addAdditionalParams_<span class="args">(<span class="arg">uri</span>)</span>
        </span>
      </div>


     <div class="entryOverview">
       Adds the additional parameters from the handler to the given URI.
     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">uri</span>
        : <div class="fullType"><span class="type"><a href="class_goog_Uri.html">goog.Uri</a></span></div>
        <div class="entryOverview">The URI to add the parameters to.</div>
     </td>
   </tr>
  </table>
      </div>
   
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line941">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry private">
       <td class="access"></td>






  <td>
    <a name="goog.net.BrowserChannel.prototype.cancelRequests_"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">cancelRequests_<span class="args">()</span>
        </span>
      </div>


     <div class="entryOverview">
       Cancels all outstanding requests.
     </div>

   
  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line596">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.net.BrowserChannel.prototype.connect"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">connect<span class="args">(<span class="arg">testPath</span>,&nbsp;<span class="arg">channelPath</span>,&nbsp;<span class="arg">extraParams</span>)</span>
        </span>
      </div>


     <div class="entryOverview">
       Starts the channel. This initiates connections to the server.
     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">testPath</span>
        : <div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span></div>
        <div class="entryOverview">The path for the test connection.</div>
     </td>
   </tr>
     
   <tr class="odd">
     <td>
        <span class="entryName">channelPath</span>
        : <div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span></div>
        <div class="entryOverview">The path for the channel connection.</div>
     </td>
   </tr>
     
   <tr class="even">
     <td>
        <span class="entryName">extraParams</span>
        : <div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Object">Object</a></span></div>
        <div class="entryOverview">Extra parameter keys and values to add to the requests.</div>
     </td>
   </tr>
  </table>
      </div>
   
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line515">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry private">
       <td class="access"></td>






  <td>
    <a name="goog.net.BrowserChannel.prototype.connectChannel_"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">connectChannel_<span class="args">()</span>
        </span>
      </div>


     <div class="entryOverview">
       Starts the regular channel which is run after the test channel is complete.
     </div>

   
  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line583">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry private">
       <td class="access"></td>






  <td>
    <a name="goog.net.BrowserChannel.prototype.connectTest_"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">connectTest_<span class="args">(<span class="arg">testPath</span>)</span>
        </span>
      </div>


     <div class="entryOverview">
       Starts the test channel to determine network conditions.
     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">testPath</span>
        : <div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span></div>
        <div class="entryOverview">The relative PATH for the test connection.</div>
     </td>
   </tr>
  </table>
      </div>
   
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line570">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.net.BrowserChannel.prototype.createDataUri"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">createDataUri<span class="args">(<span class="arg">hostPrefix</span>,&nbsp;<span class="arg">path</span>,&nbsp;<span class="arg">opt_overridePort</span>)</span>
        </span>
        &#8658; <div class="fullType"><span class="type"><a href="class_goog_Uri.html">goog.Uri</a></span></div>
      </div>


     <div class="entryOverview">
       Creates a data Uri applying logic for secondary hostprefix, port
overrides, and versioning.
     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">hostPrefix</span>
        : <div class="fullType"><span>?</span><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span></div>
        <div class="entryOverview">The host prefix.</div>
     </td>
   </tr>
     
   <tr class="odd">
     <td>
        <span class="entryName">path</span>
        : <div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span></div>
        <div class="entryOverview">The path on the host.</div>
     </td>
   </tr>
     
   <tr class="even">
     <td>
        <span class="entryName">opt_overridePort</span>
        : <div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Number">number</a></span></div>
        <div class="entryOverview">Optional override port.</div>
     </td>
   </tr>
  </table>
      </div>
   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<div class="fullType"><span class="type"><a href="class_goog_Uri.html">goog.Uri</a></span></div>&nbsp;
            The data URI.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line1362">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry private">
       <td class="access"></td>






  <td>
    <a name="goog.net.BrowserChannel.prototype.dequeueOutgoingMaps_"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">dequeueOutgoingMaps_<span class="args">()</span>
        </span>
        &#8658; <div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span></div>
      </div>


     <div class="entryOverview">
       Returns the request text from the outgoing maps and resets it.
     </div>


    <! -- Method details -->
    <div class="entryDetails">

   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span></div>&nbsp;
            The encoded request text created from all the currently queued outgoing maps.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line960">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.net.BrowserChannel.prototype.disconnect"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">disconnect<span class="args">()</span>
        </span>
      </div>


     <div class="entryOverview">
       <span class='nodesc'>No description.</span>
     </div>

   
  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line531">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry private">
       <td class="access"></td>






  <td>
    <a name="goog.net.BrowserChannel.prototype.ensureBackChannel_"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">ensureBackChannel_<span class="args">()</span>
        </span>
      </div>


     <div class="entryOverview">
       Ensures there is a backchannel request for receiving data from the server.
     </div>

   
  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line977">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry private">
       <td class="access"></td>






  <td>
    <a name="goog.net.BrowserChannel.prototype.ensureForwardChannel_"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">ensureForwardChannel_<span class="args">()</span>
        </span>
      </div>


     <div class="entryOverview">
       Ensures that a forward channel request is scheduled.
     </div>

   
  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line815">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry private">
       <td class="access"></td>






  <td>
    <a name="goog.net.BrowserChannel.prototype.ensureInState_"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">ensureInState_<span class="args">(<span class="arg">state</span>)</span>
        </span>
      </div>


     <div class="entryOverview">
       Helper to ensure the BrowserChannel is in the expected state.
     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">state</span>
        : <div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Number">number</a></span></div>
        <div class="entryOverview">The expected state.</div>
     </td>
   </tr>
  </table>
      </div>
   
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line1241">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.net.BrowserChannel.prototype.getAllowChunkedMode"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">getAllowChunkedMode<span class="args">()</span>
        </span>
        &#8658; <div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span></div>
      </div>


     <div class="entryOverview">
       Returns whether chunked mode is allowed. In certain debugging situations,
it&#39;s useful for the application to have a way to disable chunked mode for a
user.
     </div>


    <! -- Method details -->
    <div class="entryDetails">

   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span></div>&nbsp;
            Whether chunked mode is allowed.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line693">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.net.BrowserChannel.prototype.getAllowHostPrefix"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">getAllowHostPrefix<span class="args">()</span>
        </span>
        &#8658; <div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span></div>
      </div>


     <div class="entryOverview">
       Returns whether the channel allows the use of a subdomain. There may be
cases where this isn&#39;t allowed.
     </div>


    <! -- Method details -->
    <div class="entryDetails">

   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span></div>&nbsp;
            Whether a host prefix is allowed.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line658">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.net.BrowserChannel.prototype.getBackChannelUri"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">getBackChannelUri<span class="args">(<span class="arg">hostPrefix</span>,&nbsp;<span class="arg">path</span>)</span>
        </span>
        &#8658; <div class="fullType"><span class="type"><a href="class_goog_Uri.html">goog.Uri</a></span></div>
      </div>


     <div class="entryOverview">
       Gets the Uri used for the connection that receives data from the server.
     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">hostPrefix</span>
        : <div class="fullType"><span>?</span><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span></div>
        <div class="entryOverview">The host prefix.</div>
     </td>
   </tr>
     
   <tr class="odd">
     <td>
        <span class="entryName">path</span>
        : <div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span></div>
        <div class="entryOverview">The path on the host.</div>
     </td>
   </tr>
  </table>
      </div>
   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<div class="fullType"><span class="type"><a href="class_goog_Uri.html">goog.Uri</a></span></div>&nbsp;
            The back channel URI.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line1346">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.net.BrowserChannel.prototype.getChannelDebug"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">getChannelDebug<span class="args">()</span>
        </span>
        &#8658; <div class="fullType"><span class="type"><a href="class_goog_net_ChannelDebug.html">goog.net.ChannelDebug</a></span></div>
      </div>


     <div class="entryOverview">
       Returns the browserchannel logger.
     </div>


    <! -- Method details -->
    <div class="entryDetails">

   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<div class="fullType"><span class="type"><a href="class_goog_net_ChannelDebug.html">goog.net.ChannelDebug</a></span></div>&nbsp;
            The channel debug object.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line450">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.net.BrowserChannel.prototype.getExtraHeaders"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">getExtraHeaders<span class="args">()</span>
        </span>
        &#8658; <div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Object">Object</a></span></div>
      </div>


     <div class="entryOverview">
       Returns the extra HTTP headers to add to all the requests sent to the server.
     </div>


    <! -- Method details -->
    <div class="entryDetails">

   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Object">Object</a></span></div>&nbsp;
            The HTTP headers, or null.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line619">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.net.BrowserChannel.prototype.getForwardChannelMaxRetries"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">getForwardChannelMaxRetries<span class="args">()</span>
        </span>
        &#8658; <div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Number">number</a></span></div>
      </div>


     <div class="entryOverview">
       <span class='nodesc'>No description.</span>
     </div>


    <! -- Method details -->
    <div class="entryDetails">

   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Number">number</a></span></div>&nbsp;
            The max number of retries, which will be 0 in fail-fast mode.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line752">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.net.BrowserChannel.prototype.getForwardChannelUri"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">getForwardChannelUri<span class="args">(<span class="arg">path</span>)</span>
        </span>
        &#8658; <div class="fullType"><span class="type"><a href="class_goog_Uri.html">goog.Uri</a></span></div>
      </div>


     <div class="entryOverview">
       Gets the Uri used for the connection that sends data to the server.
     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">path</span>
        : <div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span></div>
        <div class="entryOverview">The path on the host.</div>
     </td>
   </tr>
  </table>
      </div>
   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<div class="fullType"><span class="type"><a href="class_goog_Uri.html">goog.Uri</a></span></div>&nbsp;
            The forward channel URI.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line1332">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.net.BrowserChannel.prototype.getHandler"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">getHandler<span class="args">()</span>
        </span>
        &#8658; <div class="fullType"><span class="type"><a href="class_goog_net_BrowserChannel_Handler.html">goog.net.BrowserChannel.Handler</a></span></div>
      </div>


     <div class="entryOverview">
       Returns the handler used for channel callback events.
     </div>


    <! -- Method details -->
    <div class="entryDetails">

   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<div class="fullType"><span class="type"><a href="class_goog_net_BrowserChannel_Handler.html">goog.net.BrowserChannel.Handler</a></span></div>&nbsp;
            The handler.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line639">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.net.BrowserChannel.prototype.getLastStatusCode"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">getLastStatusCode<span class="args">()</span>
        </span>
        &#8658; <div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Number">number</a></span></div>
      </div>


     <div class="entryOverview">
       Return the last status code received for a request.
     </div>


    <! -- Method details -->
    <div class="entryDetails">

   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Number">number</a></span></div>&nbsp;
            The last status code received for a request.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line780">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.net.BrowserChannel.prototype.getSessionId"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">getSessionId<span class="args">()</span>
        </span>
        &#8658; <div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span></div>
      </div>


     <div class="entryOverview">
       Returns the session id of the channel. Only available after the
channel has been opened.
     </div>


    <! -- Method details -->
    <div class="entryDetails">

   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span></div>&nbsp;
            Session ID.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line559">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.net.BrowserChannel.prototype.getState"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">getState<span class="args">()</span>
        </span>
        &#8658; <div class="fullType"><span class="type">goog.net.BrowserChannel.State</span></div>
      </div>


     <div class="entryOverview">
       Returns the browser channel state.
     </div>


    <! -- Method details -->
    <div class="entryDetails">

   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<div class="fullType"><span class="type">goog.net.BrowserChannel.State</span></div>&nbsp;
            The current state of the browser channel.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line772">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.net.BrowserChannel.prototype.hasOutstandingRequests"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">hasOutstandingRequests<span class="args">()</span>
        </span>
        &#8658; <div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span></div>
      </div>


     <div class="entryOverview">
       Returns whether there are outstanding requests servicing the channel.
     </div>


    <! -- Method details -->
    <div class="entryDetails">

   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span></div>&nbsp;
            true if there are outstanding requests.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line789">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.net.BrowserChannel.prototype.isActive"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">isActive<span class="args">()</span>
        </span>
        &#8658; <div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span></div>
      </div>


     <div class="entryOverview">
       Gets whether this channel is currently active. This is used to determine the
length of time to wait before retrying. This call delegates to the handler.
     </div>


    <! -- Method details -->
    <div class="entryDetails">

   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span></div>&nbsp;
            Whether the channel is currently active.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line1396">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.net.BrowserChannel.prototype.isBuffered"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">isBuffered<span class="args">()</span>
        </span>
        &#8658; <div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span></div>
      </div>


     <div class="entryOverview">
       Returns whether the channel is buffered or not. This state is valid for
querying only after the test connection has completed. This may be
queried in the goog.net.BrowserChannel.okToMakeRequest() callback.
A channel may be buffered if the test connection determines that
a chunked response could not be sent down within a suitable time.
     </div>


    <! -- Method details -->
    <div class="entryDetails">

   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span></div>&nbsp;
            Whether the channel is buffered.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line682">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.net.BrowserChannel.prototype.isClosed"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">isClosed<span class="args">()</span>
        </span>
        &#8658; <div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span></div>
      </div>


     <div class="entryOverview">
       Returns whether the channel is closed
     </div>


    <! -- Method details -->
    <div class="entryDetails">

   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span></div>&nbsp;
            true if the channel is closed.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line762">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry private">
       <td class="access"></td>






  <td>
    <a name="goog.net.BrowserChannel.prototype.makeForwardChannelRequest_"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">makeForwardChannelRequest_<span class="args">()</span>
        </span>
      </div>


     <div class="entryOverview">
       Makes a forward channel request using XMLHTTP.
     </div>

   
  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line911">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry private">
       <td class="access"></td>






  <td>
    <a name="goog.net.BrowserChannel.prototype.okToMakeRequest_"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">okToMakeRequest_<span class="args">()</span>
        </span>
        &#8658; <div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span></div>
      </div>


     <div class="entryOverview">
       Gives the handler a chance to return an error code and stop channel
execution. A handler might want to do this to check that the user is still
logged in, for example.
     </div>


    <! -- Method details -->
    <div class="entryDetails">

   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span></div>&nbsp;
            If it&#39;s OK to make a request.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line1046">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry private">
       <td class="access"></td>






  <td>
    <a name="goog.net.BrowserChannel.prototype.onClose_"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">onClose_<span class="args">()</span>
        </span>
      </div>


     <div class="entryOverview">
       Called when the channel has been closed. It notifiers the handler of the
event.
     </div>

   
  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line1318">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry private">
       <td class="access"></td>






  <td>
    <a name="goog.net.BrowserChannel.prototype.onError_"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">onError_<span class="args">(<span class="arg">error</span>)</span>
        </span>
      </div>


     <div class="entryOverview">
       Called when we&#39;ve determined the final error for a channel. It closes the
notifiers the handler of the error and closes the channel.
     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">error</span>
        : <div class="fullType"><span class="type">goog.net.BrowserChannel.Error</span></div>
        <div class="entryOverview">The error code for the failure.</div>
     </td>
   </tr>
  </table>
      </div>
   
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line1295">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry private">
       <td class="access"></td>






  <td>
    <a name="goog.net.BrowserChannel.prototype.onInput_"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">onInput_<span class="args">(<span class="arg">respArray</span>)</span>
        </span>
      </div>


     <div class="entryOverview">
       Processes the data returned by the server.
     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">respArray</span>
        : <div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array">Array</a></span></div>
        <div class="entryOverview">The response array returned by the server.</div>
     </td>
   </tr>
  </table>
      </div>
   
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line1187">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.net.BrowserChannel.prototype.onRequestComplete"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">onRequestComplete<span class="args">(<span class="arg">request</span>)</span>
        </span>
      </div>


     <div class="entryOverview">
       Callback from ChannelRequest that indicates a request has completed.
     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">request</span>
        : <div class="fullType"><span class="type"><a href="class_goog_net_ChannelRequest.html">goog.net.ChannelRequest</a></span></div>
        <div class="entryOverview">The request object.</div>
     </td>
   </tr>
  </table>
      </div>
   
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line1136">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.net.BrowserChannel.prototype.onRequestData"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">onRequestData<span class="args">(<span class="arg">request</span>,&nbsp;<span class="arg">responseText</span>)</span>
        </span>
      </div>


     <div class="entryOverview">
       Callback from ChannelRequest for when new data is received
     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">request</span>
        : <div class="fullType"><span class="type"><a href="class_goog_net_ChannelRequest.html">goog.net.ChannelRequest</a></span></div>
        <div class="entryOverview">The request object.</div>
     </td>
   </tr>
     
   <tr class="odd">
     <td>
        <span class="entryName">responseText</span>
        : <div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span></div>
        <div class="entryOverview">The text of the response.</div>
     </td>
   </tr>
  </table>
      </div>
   
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line1106">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry private">
       <td class="access"></td>






  <td>
    <a name="goog.net.BrowserChannel.prototype.onStartBackChannelTimer_"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">onStartBackChannelTimer_<span class="args">()</span>
        </span>
      </div>


     <div class="entryOverview">
       Timer callback for ensureBackChannel_.
     </div>

   
  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line997">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry private">
       <td class="access"></td>






  <td>
    <a name="goog.net.BrowserChannel.prototype.onStartForwardChannelTimer_"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">onStartForwardChannelTimer_<span class="args">()</span>
        </span>
      </div>


     <div class="entryOverview">
       Timer callback for ensureForwardChannel
     </div>

   
  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line835">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry private">
       <td class="access"></td>






  <td>
    <a name="goog.net.BrowserChannel.prototype.open_"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">open_<span class="args">()</span>
        </span>
      </div>


     <div class="entryOverview">
       Establishes a new channel session with the the server.
     </div>

   
  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line884">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry private">
       <td class="access"></td>






  <td>
    <a name="goog.net.BrowserChannel.prototype.outstandingRequests_"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">outstandingRequests_<span class="args">()</span>
        </span>
        &#8658; <div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Number">number</a></span></div>
      </div>


     <div class="entryOverview">
       Returns the number of outstanding requests.
     </div>


    <! -- Method details -->
    <div class="entryDetails">

   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Number">number</a></span></div>&nbsp;
            The number of outstanding requests to the server.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line799">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.net.BrowserChannel.prototype.sendMap"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">sendMap<span class="args">(<span class="arg">map</span>)</span>
        </span>
      </div>


     <div class="entryOverview">
       Sends a request to the server. The format of the request is a Map data
structure of key/value pairs. These maps are then encoded in a format
suitable for the wire and then reconstituted as a Map data structure that
the server can process.
     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">map</span>
        : <div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Object">Object</a></span><span>&nbsp;|&nbsp;</span><span class="type"><a href="class_goog_structs_Map.html">goog.structs.Map</a></span></div>
        <div class="entryOverview">The map to send.</div>
     </td>
   </tr>
  </table>
      </div>
   
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line717">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.net.BrowserChannel.prototype.setAllowChunkedMode"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">setAllowChunkedMode<span class="args">(<span class="arg">allowChunkedMode</span>)</span>
        </span>
      </div>


     <div class="entryOverview">
       Sets whether chunked mode is allowed. In certain debugging situations, it&#39;s
useful for the application to have a way to disable chunked mode for a user.
     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">allowChunkedMode</span>
        : <div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span></div>
        <div class="entryOverview">Whether chunked mode is allowed.</div>
     </td>
   </tr>
  </table>
      </div>
   
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line704">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.net.BrowserChannel.prototype.setAllowHostPrefix"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">setAllowHostPrefix<span class="args">(<span class="arg">allowHostPrefix</span>)</span>
        </span>
      </div>


     <div class="entryOverview">
       Sets whether the channel allows the use of a subdomain. There may be cases
where this isn&#39;t allowed, for example, logging in with troutboard where
using a subdomain causes Apache to force the user to authenticate twice.
     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">allowHostPrefix</span>
        : <div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span></div>
        <div class="entryOverview">Whether a host prefix is allowed.</div>
     </td>
   </tr>
  </table>
      </div>
   
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line669">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.net.BrowserChannel.prototype.setChannelDebug"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">setChannelDebug<span class="args">(<span class="arg">channelDebug</span>)</span>
        </span>
      </div>


     <div class="entryOverview">
       Set the browserchannel logger.
TODO: Add interface for channel loggers or remove this function.
     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">channelDebug</span>
        : <div class="fullType"><span class="type"><a href="class_goog_net_ChannelDebug.html">goog.net.ChannelDebug</a></span></div>
        <div class="entryOverview">The channel debug object.</div>
     </td>
   </tr>
  </table>
      </div>
   
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line461">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.net.BrowserChannel.prototype.setExtraHeaders"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">setExtraHeaders<span class="args">(<span class="arg">extraHeaders</span>)</span>
        </span>
      </div>


     <div class="entryOverview">
       Sets extra HTTP headers to add to all the requests sent to the server.
     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">extraHeaders</span>
        : <div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Object">Object</a></span></div>
        <div class="entryOverview">The HTTP headers, or null.</div>
     </td>
   </tr>
  </table>
      </div>
   
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line629">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.net.BrowserChannel.prototype.setFailFast"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">setFailFast<span class="args">(<span class="arg">failFast</span>)</span>
        </span>
      </div>


     <div class="entryOverview">
       When set to true, this changes the behavior of the forward channel so it
will not retry requests; it will fail after one network failure, and if
there was already one network failure, the request will fail immediately.
     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">failFast</span>
        : <div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span></div>
        <div class="entryOverview">Whether or not to fail fast.</div>
     </td>
   </tr>
  </table>
      </div>
   
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line736">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.net.BrowserChannel.prototype.setHandler"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">setHandler<span class="args">(<span class="arg">handler</span>)</span>
        </span>
      </div>


     <div class="entryOverview">
       Sets the handler used for channel callback events.
     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">handler</span>
        : <div class="fullType"><span class="type"><a href="class_goog_net_BrowserChannel_Handler.html">goog.net.BrowserChannel.Handler</a></span></div>
        <div class="entryOverview">The handler to set.</div>
     </td>
   </tr>
  </table>
      </div>
   
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line648">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry private">
       <td class="access"></td>






  <td>
    <a name="goog.net.BrowserChannel.prototype.signalError_"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">signalError_<span class="args">(<span class="arg">error</span>)</span>
        </span>
      </div>


     <div class="entryOverview">
       Signals an error has occurred.
     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">error</span>
        : <div class="fullType"><span class="type">goog.net.BrowserChannel.Error</span></div>
        <div class="entryOverview">The error code for the failure.</div>
     </td>
   </tr>
  </table>
      </div>
   
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line1254">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry private">
       <td class="access"></td>






  <td>
    <a name="goog.net.BrowserChannel.prototype.startBackChannel_"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">startBackChannel_<span class="args">()</span>
        </span>
      </div>


     <div class="entryOverview">
       Begins a new back channel operation to the server.
     </div>

   
  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line1007">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry private">
       <td class="access"></td>






  <td>
    <a name="goog.net.BrowserChannel.prototype.startForwardChannel_"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">startForwardChannel_<span class="args">()</span>
        </span>
      </div>


     <div class="entryOverview">
       Begins a new forward channel operation to the server.
     </div>

   
  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line845">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.net.BrowserChannel.prototype.testConnectionBlocked"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">testConnectionBlocked<span class="args">(<span class="arg">testChannel</span>)</span>
        </span>
      </div>


     <div class="entryOverview">
       Callback from BrowserTestChannel for when the channel is blocked.
     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">testChannel</span>
        : <div class="fullType"><span class="type"><a href="class_goog_net_BrowserTestChannel.html">goog.net.BrowserTestChannel</a></span></div>
        <div class="entryOverview">The BrowserTestChannel.</div>
     </td>
   </tr>
  </table>
      </div>
   
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line1093">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.net.BrowserChannel.prototype.testConnectionFailure"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">testConnectionFailure<span class="args">(<span class="arg">testChannel</span>,&nbsp;<span class="arg">errorCode</span>)</span>
        </span>
      </div>


     <div class="entryOverview">
       Callback from BrowserTestChannel for when the channel has an error.
     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">testChannel</span>
        : <div class="fullType"><span class="type"><a href="class_goog_net_BrowserTestChannel.html">goog.net.BrowserTestChannel</a></span></div>
        <div class="entryOverview">The BrowserTestChannel.</div>
     </td>
   </tr>
     
   <tr class="odd">
     <td>
        <span class="entryName">errorCode</span>
        : <div class="fullType"><span class="type">goog.net.ChannelRequest.Error</span></div>
        <div class="entryOverview">The error code of the failure.</div>
     </td>
   </tr>
  </table>
      </div>
   
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line1081">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.net.BrowserChannel.prototype.testConnectionFinished"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">testConnectionFinished<span class="args">(<span class="arg">testChannel</span>,&nbsp;<span class="arg">useChunked</span>)</span>
        </span>
      </div>


     <div class="entryOverview">
       Callback from BrowserTestChannel for when the channel is finished.
     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">testChannel</span>
        : <div class="fullType"><span class="type"><a href="class_goog_net_BrowserTestChannel.html">goog.net.BrowserTestChannel</a></span></div>
        <div class="entryOverview">The BrowserTestChannel.</div>
     </td>
   </tr>
     
   <tr class="odd">
     <td>
        <span class="entryName">useChunked</span>
        : <div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span></div>
        <div class="entryOverview">Whether we can chunk responses.</div>
     </td>
   </tr>
  </table>
      </div>
   
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line1065">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry private">
       <td class="access"></td>






  <td>
    <a name="goog.net.BrowserChannel.prototype.testGoogleComCallback_"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryName">testGoogleComCallback_<span class="args">(<span class="arg">error</span>,&nbsp;<span class="arg">networkUp</span>)</span>
        </span>
      </div>


     <div class="entryOverview">
       Callback for testGoogleCom during error handling.
     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">error</span>
        : <div class="fullType"><span class="type">goog.net.BrowserChannel.Error</span></div>
        <div class="entryOverview">The error code for the failure.</div>
     </td>
   </tr>
     
   <tr class="odd">
     <td>
        <span class="entryName">networkUp</span>
        : <div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span></div>
        <div class="entryOverview">Whether the network is up.</div>
     </td>
   </tr>
  </table>
      </div>
   
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line1277">code &raquo;</a>
  </td>
     </tr>


  </table>
</div>
</div>




<h2>Instance Properties</h2>







<div>
       <div class="desc">
         Defined in
         <span class="fn-name">
            <a href="class_goog_net_BrowserChannel.html">
              goog.net.BrowserChannel
            </a>
         </span>
       </div>






<div class="section">
  <table class="horiz-rule">


     <tr class="even entry private">
       <td class="access"></td>





  <a name="goog.net.BrowserChannel.prototype.backChannelRequest_"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryName">backChannelRequest_</span>
        : <div class="fullType"><span>?</span><span class="type"><a href="class_goog_net_ChannelRequest.html">goog.net.ChannelRequest</a></span></div>
     </div>


     <div class="entryOverview">
       The ChannelRequest object for the backchannel.
     </div>

  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line119">Code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry private">
       <td class="access"></td>





  <a name="goog.net.BrowserChannel.prototype.backChannelTimerId_"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryName">backChannelTimerId_</span>
        : <div class="fullType"><span>?</span><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Number">number</a></span></div>
     </div>


     <div class="entryOverview">
       Timer identifier for asynchronously making a back channel request.
     </div>

  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line191">Code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry private">
       <td class="access"></td>





  <a name="goog.net.BrowserChannel.prototype.backChannelUri_"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryName">backChannelUri_</span>
        : <div class="fullType"><span class="type"><a href="class_goog_Uri.html">goog.Uri</a></span></div>
     </div>


     <div class="entryOverview">
       The absolute URI for the backchannel request.
     </div>

  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line141">Code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry private">
       <td class="access"></td>





  <a name="goog.net.BrowserChannel.prototype.connectionTest_"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryName">connectionTest_</span>
        : <div class="fullType"><span>?</span><span class="type"><a href="class_goog_net_BrowserTestChannel.html">goog.net.BrowserTestChannel</a></span></div>
     </div>


     <div class="entryOverview">
       The BrowserTestChannel object which encapsulates the logic for determining
interesting network conditions about the client.
     </div>

  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line199">Code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry private">
       <td class="access"></td>





  <a name="goog.net.BrowserChannel.prototype.extraHeaders_"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryName">extraHeaders_</span>
        : <div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Object">Object</a></span></div>
     </div>


     <div class="entryOverview">
       Extra HTTP headers to add to all the requests sent to the server.
     </div>

  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line98">Code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry private">
       <td class="access"></td>





  <a name="goog.net.BrowserChannel.prototype.extraParams_"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryName">extraParams_</span>
        : <div class="fullType"><span>?</span><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Object">Object</a></span></div>
     </div>


     <div class="entryOverview">
       Extra parameters to add to all the requests sent to the server.
     </div>

  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line105">Code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry private">
       <td class="access"></td>





  <a name="goog.net.BrowserChannel.prototype.failFast_"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryName">failFast_</span>
        : <div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span></div>
     </div>


     <div class="entryOverview">
       Whether to fail forward-channel requests after one try, or after a few tries.
     </div>

  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line170">Code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry private">
       <td class="access"></td>





  <a name="goog.net.BrowserChannel.prototype.forwardChannelRequest_"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryName">forwardChannelRequest_</span>
        : <div class="fullType"><span>?</span><span class="type"><a href="class_goog_net_ChannelRequest.html">goog.net.ChannelRequest</a></span></div>
     </div>


     <div class="entryOverview">
       The current ChannelRequest object for the forwardchannel.
     </div>

  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line112">Code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry private">
       <td class="access"></td>





  <a name="goog.net.BrowserChannel.prototype.forwardChannelTimerId_"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryName">forwardChannelTimerId_</span>
        : <div class="fullType"><span>?</span><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Number">number</a></span></div>
     </div>


     <div class="entryOverview">
       Timer identifier for asynchronously making a forward channel request.
     </div>

  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line184">Code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry private">
       <td class="access"></td>





  <a name="goog.net.BrowserChannel.prototype.forwardChannelUri_"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryName">forwardChannelUri_</span>
        : <div class="fullType"><span class="type"><a href="class_goog_Uri.html">goog.Uri</a></span></div>
     </div>


     <div class="entryOverview">
       The absolute URI for the forwardchannel request.
     </div>

  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line134">Code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry private">
       <td class="access"></td>





  <a name="goog.net.BrowserChannel.prototype.handler_"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryName">handler_</span>
        : <div class="fullType"><span class="type"><a href="class_goog_net_BrowserChannel_Handler.html">goog.net.BrowserChannel.Handler</a></span></div>
     </div>


     <div class="entryOverview">
       The handler that receive callbacks for state changes and data.
     </div>

  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line177">Code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry private">
       <td class="access"></td>





  <a name="goog.net.BrowserChannel.prototype.hostPrefix_"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryName">hostPrefix_</span>
        : <div class="fullType"><span>?</span><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span></div>
     </div>


     <div class="entryOverview">
       A subdomain prefix for using a subdomain in IE for the backchannel
requests.
     </div>

  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line149">Code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry private">
       <td class="access"></td>





  <a name="goog.net.BrowserChannel.prototype.lastArrayId_"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryName">lastArrayId_</span>
        : <div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Number">number</a></span></div>
     </div>


     <div class="entryOverview">
       The array identifier of the last array received from the server for the
backchannel request.
     </div>

  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line221">Code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry private">
       <td class="access"></td>





  <a name="goog.net.BrowserChannel.prototype.lastStatusCode_"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryName">lastStatusCode_</span>
        : <div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Number">number</a></span></div>
     </div>


     <div class="entryOverview">
       The last status code received.
     </div>

  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line228">Code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry private">
       <td class="access"></td>





  <a name="goog.net.BrowserChannel.prototype.nextRid_"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryName">nextRid_</span>
        : <div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Number">number</a></span></div>
     </div>


     <div class="entryOverview">
       The next id to use for the RID (request identifier) parameter. This
identifier uniquely identifies the forward channel request.
     </div>

  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line163">Code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry private">
       <td class="access"></td>





  <a name="goog.net.BrowserChannel.prototype.path_"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryName">path_</span>
        : <div class="fullType"><span>?</span><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span></div>
     </div>


     <div class="entryOverview">
       The relative path (in the context of the the page hosting the browser
channel) for making requests to the server.
     </div>

  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line127">Code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry private">
       <td class="access"></td>





  <a name="goog.net.BrowserChannel.prototype.useChunked_"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryName">useChunked_</span>
        : <div class="fullType"><span>?</span><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Boolean">boolean</a></span></div>
     </div>


     <div class="entryOverview">
       Whether the client&#39;s network conditions can support chunked responses.
     </div>

  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line206">Code &raquo;</a>
  </td>
     </tr>


  </table>
</div>
</div>




<h2>Static Methods</h2>






<div class="section">
  <table class="horiz-rule">


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.net.BrowserChannel.endExecutionHook_"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.net.BrowserChannel.</span><span class="entryName">endExecutionHook_<span class="args">()</span>
        </span>
      </div>


     <div class="entryOverview">
       <span class='nodesc'>No description.</span>
     </div>

   
  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line485">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.net.BrowserChannel.getStatEventTarget"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.net.BrowserChannel.</span><span class="entryName">getStatEventTarget<span class="args">()</span>
        </span>
        &#8658; <div class="fullType"><span class="type"><a href="class_goog_events_EventTarget.html">goog.events.EventTarget</a></span></div>
      </div>


     <div class="entryOverview">
       Returns the singleton event target for stat events.
     </div>


    <! -- Method details -->
    <div class="entryDetails">

   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<div class="fullType"><span class="type"><a href="class_goog_events_EventTarget.html">goog.events.EventTarget</a></span></div>&nbsp;
            The event target for stat events.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line1443">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.net.BrowserChannel.notifyStatEvent"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.net.BrowserChannel.</span><span class="entryName">notifyStatEvent<span class="args">(<span class="arg">stat</span>)</span>
        </span>
      </div>


     <div class="entryOverview">
       Helper function to call the stat event callback.
     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">stat</span>
        : <div class="fullType"><span class="type">goog.net.BrowserChannel.Stat</span></div>
        <div class="entryOverview">The stat.</div>
     </td>
   </tr>
  </table>
      </div>
   
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line1452">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.net.BrowserChannel.onEndExecution"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.net.BrowserChannel.</span><span class="entryName">onEndExecution<span class="args">()</span>
        </span>
      </div>


     <div class="entryOverview">
       <span class='nodesc'>No description.</span>
     </div>

   
  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line1434">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.net.BrowserChannel.onStartExecution"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.net.BrowserChannel.</span><span class="entryName">onStartExecution<span class="args">()</span>
        </span>
      </div>


     <div class="entryOverview">
       <span class='nodesc'>No description.</span>
     </div>

   
  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line1426">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.net.BrowserChannel.setEndThreadExecutionHook"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.net.BrowserChannel.</span><span class="entryName">setEndThreadExecutionHook<span class="args">(<span class="arg">endHook</span>)</span>
        </span>
      </div>


     <div class="entryOverview">
       Allows the application to set an execution hooks for when BrowserChannel
stops processing requests. This is useful to track timing or logging
special information. The function takes no parameters and return void.
     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">endHook</span>
        : <div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Function">Function</a></span></div>
        <div class="entryOverview">The function for the end hook.</div>
     </td>
   </tr>
  </table>
      </div>
   
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line484">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.net.BrowserChannel.setStartThreadExecutionHook"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.net.BrowserChannel.</span><span class="entryName">setStartThreadExecutionHook<span class="args">(<span class="arg">startHook</span>)</span>
        </span>
      </div>


     <div class="entryOverview">
       Allows the application to set an execution hooks for when BrowserChannel
starts processing requests. This is useful to track timing or logging
special information. The function takes no parameters and return void.
     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">startHook</span>
        : <div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Function">Function</a></span></div>
        <div class="entryOverview">The function for the start hook.</div>
     </td>
   </tr>
  </table>
      </div>
   
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line473">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.net.BrowserChannel.setTimeout"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.net.BrowserChannel.</span><span class="entryName">setTimeout<span class="args">(<span class="arg">fn</span>,&nbsp;<span class="arg">ms</span>)</span>
        </span>
        &#8658; <div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Number">number</a></span></div>
      </div>


     <div class="entryOverview">
       Wrapper around SafeTimeout which calls the start and end execution hooks
with a try...finally block.
     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">fn</span>
        : <div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Function">Function</a></span></div>
        <div class="entryOverview">The callback function.</div>
     </td>
   </tr>
     
   <tr class="odd">
     <td>
        <span class="entryName">ms</span>
        : <div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Number">number</a></span></div>
        <div class="entryOverview">The time in MS for the timer.</div>
     </td>
   </tr>
  </table>
      </div>
   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Number">number</a></span></div>&nbsp;
            The ID of the timer.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line1408">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.net.BrowserChannel.startExecutionHook_"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.net.BrowserChannel.</span><span class="entryName">startExecutionHook_<span class="args">()</span>
        </span>
      </div>


     <div class="entryOverview">
       <span class='nodesc'>No description.</span>
     </div>

   
  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line474">code &raquo;</a>
  </td>
     </tr>


  </table>
</div>



<h2>Static Properties</h2>






<div class="section">
  <table class="horiz-rule">


     <tr class="even entry public">
       <td class="access"></td>





  <a name="goog.net.BrowserChannel.BACK_CHANNEL_XMHTTP_MAX_RETRIES"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.net.BrowserChannel.</span><span class="entryName">BACK_CHANNEL_XMHTTP_MAX_RETRIES</span>
        : <div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Number">number</a></span></div>
     </div>


     <div class="entryOverview">
       Maximum number of attempts to connect to the server for back channel
requests that are performed over XMLHTTP.
     </div>

  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line268">Code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>





  <a name="goog.net.BrowserChannel.Event"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.net.BrowserChannel.</span><span class="entryName">Event</span>
        : <div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Object">Object</a></span></div>
     </div>


     <div class="entryOverview">
       Events fired by BrowserChannel and associated objects
     </div>

  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line326">Code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>





  <a name="goog.net.BrowserChannel.FORWARD_CHANNEL_MAX_RETRIES"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.net.BrowserChannel.</span><span class="entryName">FORWARD_CHANNEL_MAX_RETRIES</span>
        : <div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Number">number</a></span></div>
     </div>


     <div class="entryOverview">
       Maximum number of attempts to connect to the server for forward channel
requests.
     </div>

  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line255">Code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>





  <a name="goog.net.BrowserChannel.FORWARD_CHANNEL_RETRY_TIMEOUT"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.net.BrowserChannel.</span><span class="entryName">FORWARD_CHANNEL_RETRY_TIMEOUT</span>
        : <div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Number">number</a></span></div>
     </div>


     <div class="entryOverview">
       The timeout in milliseconds for a forward channel request.
     </div>

  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line261">Code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>





  <a name="goog.net.BrowserChannel.MAGIC_RESPONSE_COOKIE"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.net.BrowserChannel.</span><span class="entryName">MAGIC_RESPONSE_COOKIE</span>
        : <div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span></div>
     </div>


     <div class="entryOverview">
       Magic response cookie that is the response for forward channel requests.
     </div>

  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line442">Code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>





  <a name="goog.net.BrowserChannel.VERSION"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.net.BrowserChannel.</span><span class="entryName">VERSION</span>
        : <div class="fullType"><span class="type"><a href="http://www.google.com/url?sa=D&q=https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Number">number</a></span></div>
     </div>


     <div class="entryOverview">
       The version of the protocol used.
     </div>

  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line275">Code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry private">
       <td class="access"></td>





  <a name="goog.net.BrowserChannel.statEventTarget_"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.net.BrowserChannel.</span><span class="entryName">statEventTarget_</span>
        : <div class="fullType"><span class="type"><a href="class_goog_events_EventTarget.html">goog.events.EventTarget</a></span></div>
     </div>


     <div class="entryOverview">
       Singleton event target for firing stat events
     </div>

  </td>


  <td class="view-code">
     <a href="closure_goog_net_browserchannel.js.source.html#line320">Code &raquo;</a>
  </td>
     </tr>


  </table>
</div>
      <!-- Column 1 end -->
    </div>

        <div class="col2">
          <!-- Column 2 start -->
          <div class="col2-c">
            <h2 id="ref-head">Package net</h2>
            <div id="localView"></div>
          </div>

          <div class="col2-c">
            <h2 id="ref-head">Package Reference</h2>
            <div id="sideTypeIndex" rootPath="goog" current="net.BrowserChannel"></div>
          </div>
          <!-- Column 2 end -->
        </div>
</div>
</div>

</body>
</html>
